IApi.WriteSlaveEEprom method

Writes a double word into a slave's EEPROM.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB
KsCommandStatus WriteSlaveEEprom(
       int SlaveId,
       int Offset,
       uint Data
)
Function WriteSlaveEEprom(
       SlaveId As Integer,
       Offset As Integer,
       Data As UInteger
) As KsCommandStatus

Parameters

SlaveId

Type: int

The index of a slave array. When EtherCAT is started, this index has the same value as the SlaveId, which corresponds to the position of the slave in the network. Please note that after EtherCAT is started in the Operational (Op) state, any addition or removal of slaves from the network will change the position of the slaves in the network (SlaveId). Nevertheless, the index of the slave will remain the same. Newly added devices will be added in the back of the slave array. For all slaves after the change, the index and SlaveId will no longer match. This behavior is only available for physical devices; simulated devices are inapplicable. Please refer to the use cases in EnableHotConnect for more details.

 

Offset

Type: int

The offset in the EEPROM space.

 

Data

Type: uint

The value to be written.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Usable EtherCAT states

ecatInit, ecatPreOP, ecatSafeOP, ecatOP

Examples

C#
N/A

See also

IApi Interface

IntervalZero.KINGSTAR.Base.Api Namespace